Entity Container
Container is the Entity definition for a container.
Subclass of Usable.
Functions
| GetMaxWeight () | GetMaxWeight returns the maximum carrying capacity of the container. |
| GetUnlockChance () | GetUnlockChance returns the chance to unlock for a locked container. |
| IsOpen () | IsOpen returns true if the container is currently open. |
| AlwaysOpen () | AlwaysOpen returns true if the container is always open. |
| IsLocked () | IsLocked returns true if the container is currently locked. |
| IsLockable () | IsLockable returns true if the container is lockable. |
| GetAction () | GetAction returns an action string for the container (used in animation). |
| GetSound () | GetSound returns the sound effect played when the container is used. |
Functions
- GetMaxWeight ()
-
GetMaxWeight returns the maximum carrying capacity of the container.
Returns:
-
An integer indicating the max weight capacity of the container.
- GetUnlockChance ()
-
GetUnlockChance returns the chance to unlock for a locked container.
Returns:
-
An integer indicating the unlock chance.
- IsOpen ()
-
IsOpen returns true if the container is currently open.
Returns:
-
A boolean indicating if the container is open.
- AlwaysOpen ()
-
AlwaysOpen returns true if the container is always open.
Returns:
-
A boolean indicating if the container is always open.
- IsLocked ()
-
IsLocked returns true if the container is currently locked.
Returns:
-
A boolean indicating if the container is locked.
- IsLockable ()
-
IsLockable returns true if the container is lockable.
Returns:
-
A boolean indicating if the container is lockable.
- GetAction ()
-
GetAction returns an action string for the container (used in animation).
Returns:
-
A string indicating the current action for the container.
- GetSound ()
-
GetSound returns the sound effect played when the container is used.
Returns:
-
A string indicating the sound effect name.